Reorganize the contents of a few proto files #331
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit reorganizes the contents of the following proto files: - `communication_components.proto` - `electrical_components.proto` - `sensors.proto` The reorganization includes: - Moving the enums to the top of the file for better visibility and organization. - Sequencing the messages in an arbitrary logical order, ensuring that related messages are grouped together. Signed-off-by: Tiyash Basu <[email protected]>
github-actions
bot
added
the
part:protobuf
tiyash-basu-frequenz
added
cmd:skip-release-notes
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR reorganizes proto files to improve clarity and maintainability by moving enums to the top and reordering related messages.
- Enums are now positioned before message definitions for better visibility.
- Duplicate definitions have been removed and messages reorganized to group related data together.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto | Reordered enums and messages; consolidated SensorData definition and related enums for consistency. |
| proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto | Reordered messages and shifted MetricConfigBounds, ElectricalComponent, and related types to a consistent order. |
| proto/frequenz/api/common/v1/microgrid/communication_components/communication_components.proto | Reorganized enum and message definitions; updated comments to clarify snapshot semantics and component categorization. |
proto/frequenz/api/common/v1/microgrid/communication_components/communication_components.proto
Outdated
Show resolved
Hide resolved
Signed-off-by: Tiyash Basu <[email protected]>
Signed-off-by: Tiyash Basu <[email protected]>
github-actions
bot
added
the
part:protobuf
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR reorganizes proto files by moving enum definitions to the top and sequencing related message types for clarity without changing any message schemas.
- Relocated enum declarations ahead of dependent messages in all three files.
- Grouped related messages (e.g., metadata, component, data snapshots) together for logical cohesion.
- Removed duplicate definitions to maintain a single source of truth per type.
llucax
approved these changes
May 15, 2025
Contributor
llucax
left a comment
llucax
left a comment
There was a problem hiding this comment.
I didn't look to the diff as it is very hard to read, so I assume no code was changed, only things were moved around. I looked at the resulting files and LGTM.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit reorganizes the contents of the following proto files:
communication_components.protoelectrical_components.protosensors.protoThe reorganization includes:
This PR does not change the protobuf messages themselves in any way.